Separate a reusable Image class from Screen #834

Epixu · 2024-03-29T15:22:52Z

Context:

I'm making a custom ASCII rasterizer of sorts, and I needed direct control on what's rendered to a Canvas. So I took the liberty to make some changes:

Main changes:

Separated Image from Screen to avoid tinkering with Windows console on construction
Added Canvas::DrawPixel and Canvas::DrawImage

Example use case:

Image backbuffer;
// (...render to backbuffer or load an 'image'...)
auto component = Renderer([&] {
  auto my_image = canvas([&](Canvas& c) {
     c.DrawPointLine(0, 0, c.width(), c.height());
     c.DrawImage(0, 0, backbuffer); // directly draw the pixels of the image
  });
  return my_image | flex;
});

Secondary changes:

a. Added Box::Area method for convenience
b. .gitignored autogenerated directory by MSVC's CMake integration

Considerations:

I did run the tests on windows 10, they sometimes run, sometimes fail at these interrupt tests, not sure if this is normal or not:

FTXUI/src/ftxui/component/screen_interactive_test.cpp

Lines 34 to 51 in ce5ac6b

    
           TEST(ScreenInteractive, Signal_SIGTERM) { 
        
             TestSignal(SIGTERM); 
        
           } 
        
           TEST(ScreenInteractive, Signal_SIGSEGV) { 
        
             TestSignal(SIGSEGV); 
        
           } 
        
           TEST(ScreenInteractive, Signal_SIGINT) { 
        
             TestSignal(SIGINT); 
        
           } 
        
           TEST(ScreenInteractive, Signal_SIGILL) { 
        
             TestSignal(SIGILL); 
        
           } 
        
           TEST(ScreenInteractive, Signal_SIGABRT) { 
        
             TestSignal(SIGABRT); 
        
           } 
        
           TEST(ScreenInteractive, Signal_SIGFPE) { 
        
             TestSignal(SIGFPE); 
        
           }

Additional notes:

I might be doing more occasional pull requests in the future, including regarding my issue #778 - I have a couple of optimizations in mind for the near future. If you think these changes are out of the scope of your library and don't need the spam, inform me and I'll stick to a fork!

All the best,
Dimo Markov

…Added Canvas methods for drawing Pixels/Images directly

ArthurSonzogni · 2024-03-30T10:42:31Z

Excellent! I like it!

Epixu · 2024-03-30T10:43:11Z

Okay, but don't merge it yet, I'll add tests for it, as well as some bug fixes. I'll add a couple of more commits to this one :)

.gitignore

ArthurSonzogni · 2024-03-30T10:35:40Z

include/ftxui/screen/box.hpp

@@ -15,6 +15,7 @@ struct Box {
  static auto Intersection(Box a, Box b) -> Box;
  static auto Union(Box a, Box b) -> Box;
  bool Contain(int x, int y) const;
+  int Area() const noexcept;


FTXUI already ban using C++ exception. I would remove the noexcept here, because it feel superfluous and inconsistent with every other functions.

What about adding Width() and Height() instead?

Noted about noexcept
I can add Width() and Height() also, but it is often used like if (Width() > 0 and Height() > 0) when checking boxes, so i decided it would be most convenient to check it through the area, with the added benefit of checking for negatives

What about Area::IsEmpty()?

(I pushed a patch for adding it instead)

ArthurSonzogni · 2024-03-30T10:35:48Z

include/ftxui/screen/image.hpp

@@ -0,0 +1,87 @@
+// Copyright 2020 Arthur Sonzogni. All rights reserved.


ArthurSonzogni · 2024-03-30T10:36:14Z

include/ftxui/screen/image.hpp

+/// @brief A unicode character and its associated style.
+/// @ingroup screen
+struct Pixel {
+  Pixel()
+      : blink(false),
+        bold(false),
+        dim(false),
+        inverted(false),
+        underlined(false),
+        underlined_double(false),
+        strikethrough(false),
+        automerge(false) {}
+
+  // A bit field representing the style:
+  bool blink : 1;
+  bool bold : 1;
+  bool dim : 1;
+  bool inverted : 1;
+  bool underlined : 1;
+  bool underlined_double : 1;
+  bool strikethrough : 1;
+  bool automerge : 1;
+
+  // The hyperlink associated with the pixel.
+  // 0 is the default value, meaning no hyperlink.
+  // It's an index for accessing Screen meta data
+  uint8_t hyperlink = 0;
+
+  // The graphemes stored into the pixel. To support combining characters,
+  // like: a?, this can potentially contain multiple codepoints.
+  std::string character = " ";
+
+  // Colors:
+  Color background_color = Color::Default;
+  Color foreground_color = Color::Default;
+};


While you are here, this might deserve its own file?

ArthurSonzogni · 2024-03-30T10:40:29Z

src/ftxui/dom/canvas.cpp

+  for (int py = y; py < yend; ++py) {
+    for (int px = x; px < xend; ++px) {
+      Cell& cell = storage_[XY{px, py}];
+      cell.type = CellType::kText;  // Epixu: should we add kCustom or something?


kText sounds appropriate to me. We are covering the whole cell.

But kText seems a bit weird in that context, probably rename those to:
CellType::BrailleSegment, CellType::BlockSegment, and CellType::Uniform ?
Probably doesn't matter too much, but still?
Because I'm having some ideas about drawing text, but large and segmented, like big ASCII letters. Here's an example:

_ ____ ____ ___ ___ _ _ _ _ _ / \ / ___| / ___|_ _|_ _| / \ _ __| |_ / \ _ __ ___| |__ (_)_ _____ / _ \ \___ \| | | | | | / _ \ | '__| __| / _ \ | '__/ __| '_ \| \ \ / / _ \ / ___ \ ___) | |___ | | | | / ___ \| | | |_ / ___ \| | | (__| | | | |\ V / __/ /_/ \_\____/ \____|___|___| /_/ \_\_| \__| /_/ \_\_| \___|_| |_|_| \_/ \___|

src/ftxui/screen/image.cpp

Epixu · 2024-04-12T11:23:55Z

Thanks for the support, I'm sorry that I'm a bit slow on this, but I've got a lot of stuff on my backlog

ArthurSonzogni · 2024-04-27T09:03:52Z

Merged! Thanks for your patience!

Epixu · 2024-05-10T14:44:49Z

With these changes, I was able to resterize and display this:

Just thought it would be fun to share :)

ArthurSonzogni · 2024-05-12T11:39:06Z

Nice 3D renderer !

Co-authored-by: ArthurSonzogni <sonzogniarthur@gmail.com>

Separated Image from Screen to avoid tinkering with Windows console; …

3d6c48e

…Added Canvas methods for drawing Pixels/Images directly

Epixu mentioned this pull request Apr 2, 2024

Allow Canvas re-use for optimization #836

Closed

ArthurSonzogni reviewed Apr 7, 2024

View reviewed changes

ArthurSonzogni added 4 commits April 11, 2024 23:07

Add Box::IsEmpty()

0279bed

Move pixel to its own file.

9eccde5

Update copyright date.

94b0e97

Rename Canvas::CellType::kText and simplify.

6e61352

ArthurSonzogni merged commit 293ff17 into ArthurSonzogni:main Apr 27, 2024
9 checks passed

ArthurSonzogni added a commit that referenced this pull request Dec 26, 2024

Separate a reusable Image class from Screen (#834)

53b50df

Co-authored-by: ArthurSonzogni <sonzogniarthur@gmail.com>

ArthurSonzogni added a commit that referenced this pull request Dec 26, 2024

Separate a reusable Image class from Screen (#834)

a006bca

Co-authored-by: ArthurSonzogni <sonzogniarthur@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Separate a reusable Image class from Screen #834

Separate a reusable Image class from Screen #834

Epixu commented Mar 29, 2024 •

edited

Loading

ArthurSonzogni commented Mar 30, 2024

Epixu commented Mar 30, 2024

ArthurSonzogni Mar 30, 2024

ArthurSonzogni Mar 30, 2024

Epixu Apr 10, 2024

ArthurSonzogni Apr 11, 2024

ArthurSonzogni Mar 30, 2024

ArthurSonzogni Mar 30, 2024

Epixu Apr 10, 2024

ArthurSonzogni Apr 11, 2024

ArthurSonzogni Mar 30, 2024

Epixu Apr 11, 2024 •

edited

Loading

Epixu commented Apr 12, 2024

ArthurSonzogni commented Apr 27, 2024

Epixu commented May 10, 2024

ArthurSonzogni commented May 12, 2024

	TEST(ScreenInteractive, Signal_SIGTERM) {
	TestSignal(SIGTERM);
	}
	TEST(ScreenInteractive, Signal_SIGSEGV) {
	TestSignal(SIGSEGV);
	}
	TEST(ScreenInteractive, Signal_SIGINT) {
	TestSignal(SIGINT);
	}
	TEST(ScreenInteractive, Signal_SIGILL) {
	TestSignal(SIGILL);
	}
	TEST(ScreenInteractive, Signal_SIGABRT) {
	TestSignal(SIGABRT);
	}
	TEST(ScreenInteractive, Signal_SIGFPE) {
	TestSignal(SIGFPE);
	}

		@@ -0,0 +1,87 @@
		// Copyright 2020 Arthur Sonzogni. All rights reserved.

Separate a reusable Image class from Screen #834

Separate a reusable Image class from Screen #834

Conversation

Epixu commented Mar 29, 2024 • edited Loading

Context:

Main changes:

Example use case:

Secondary changes:

Considerations:

Additional notes:

ArthurSonzogni commented Mar 30, 2024

Epixu commented Mar 30, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Epixu Apr 11, 2024 • edited Loading

Choose a reason for hiding this comment

Epixu commented Apr 12, 2024

ArthurSonzogni commented Apr 27, 2024

Epixu commented May 10, 2024

ArthurSonzogni commented May 12, 2024

Epixu commented Mar 29, 2024 •

edited

Loading

Epixu Apr 11, 2024 •

edited

Loading